/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.nio;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.NetworkChannel;
import java.nio.channels.SelectionKey;
import java.util.function.BiConsumer;

public interface NioChannel {

    boolean isOpen();

    InetSocketAddress getLocalAddress();

    void close();

    void closeFromSelector() throws IOException;

    void register() throws ClosedChannelException;

    ESSelector getSelector();

    SelectionKey getSelectionKey();

    NetworkChannel getRawChannel();

    /**
     * Adds a close listener to the channel. Multiple close listeners can be added. There is no guarantee
     * about the order in which close listeners will be executed. If the channel is already closed, the
     * listener is executed immediately.
     *
     * @param listener to be called at close
     */
    void addCloseListener(BiConsumer<Void, Throwable> listener);
}
